Add option to hide docstring in signatures #686
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Author
|
This PR is updated version of #589. |
ccordoba12
reviewed
Dec 4, 2025
Member
ccordoba12
left a comment
ccordoba12
left a comment
There was a problem hiding this comment.
A couple of suggestions for you @tomekwojcik, the rest looks good to me.
Also, please rebase on top of develop to run our tests with newer Python versions.
ccordoba12
changed the title
ccordoba12
changed the title
tomekwojcik
force-pushed
the
allow_signature_to_hide_docstrings
branch
from
5a50b50 to
d5788b5
Compare
Contributor
Author
|
Thanks for your comments, @ccordoba12. I implemented the changes you requested and rebased on top of develop. |
ccordoba12
changed the title
ccordoba12
approved these changes
Dec 6, 2025
Member
ccordoba12
left a comment
ccordoba12
left a comment
There was a problem hiding this comment.
Looks good to me now, thanks @tomekwojcik for your contribution!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Both
jedi_hoverandjedi)signatureplugins include a signature's docstring by the default in the content they generate. Which is cool, as long as the docstring's author doesn't moonlight as a novelist. Otherwise, the content rendered in the popup will cover the entire screen. It's annoying to say the least.This changeset allows a user to hide the signature docstrings by adding a config flag. It defaults to true so people aren't surprised by the change. I've been running this version in ST4 with no issues for a while, so I'm submitting it as a PR.